home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / remote / vd170r1.zip / VD.DOC < prev    next >
Text File  |  1993-03-06  |  31KB  |  985 lines
  1. PRELIMINARY DOCUMENTATION PRELIMINARY DOCUMENTATION PRELIMINARY DOCUMENTATION
  2.  
  3. THIS DOCUMENTATION IS NOT FINISHED BUT WAS INCLUDED ANYWAY IN ORDER TO GET THE 
  4. NEW RELEASE OUT A.S.A.P.  PLEASE REFER TO THE ENCLOSED VD.CFG FILE FOR INFO ON 
  5. SETTING UP VALIDOOR.
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.           V       V  A     L     III  DDDD   OOOOO  OOOOO  RRRR
  17.            V     V  A A    L      I   D   D  O   O  O   O  R   R
  18.             V   V  AAAAA   L      I   D   D  O   O  O   O  RRRR
  19.              V V  A     A  L      I   D   D  O   O  O   O  R  R
  20.               V  A       A LLLLL III  DDDD   OOOOO  OOOOO  R   R
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31. Documentation
  32. Version  2.00
  33.  
  34.  
  35.  
  36.  
  37. Copyright (c)1989-93, Cabell B. Clarke Jr.
  38. ALL RIGHTS RESERVED.
  39.  
  40.  
  41. The Boot Factory BBS
  42. --------------------
  43. FidoNET 1:264/19
  44. 3/12/24/96/144 v32bis
  45. (804) 262-9289
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55. Disclaimer
  56. This software is sold "AS IS".  It is not guaranteed to work at all. If it 
  57. trashes your system or ruins your life, you have been warned.  I am not 
  58. responsible for any damages incurred from the use or misuse of this software.
  59.  
  60.  
  61.  
  62.  
  63. ValidOOR is a User Validation Door written for the RemoteAccess Bulletin Board 
  64. System.  ValidOOR allows Sysops to have their systems call users back in order 
  65. to verify that they have left a valid phone number for the sysop's records.  
  66. Validoor then updates the user's BBS record so he can call right back and have 
  67. access to the BBS.  This saves the sysops time and trouble of manually 
  68. validating users.  Be forewarned *** ValidOOR is NOT designed to keep unwanted 
  69. users off of your BBS.  It will not keep a determined person off.***  It will 
  70. validate your users so you don't have to manually do that.
  71.  
  72. ValidOOR is being released as Shareware.  This means you are free to evaluate 
  73. the program for 30 days.  If it meets your needs, you are then expected to 
  74. register your copy by sending me a registration fee.  Registering ValidOOR 
  75. entitles you to all minor releases of Version 1 of ValidOOR (1.00-1.99).  It 
  76. also grants you access to the ValidOOR Support Forum on my BBS which contains 
  77. ValidOOR utilities.  Users who register Version 1 of ValidOOR are entitled to 
  78. Version 2 free of charge.  There will possibly be an upgrade fee to version 3 
  79. but remember I originally said the same thing about version 2.
  80.  
  81. Unregistered versions of ValidOOR will have a 30 second delay built-in to the 
  82. program.  The KEY file will eliminate this delay and inform the rest of the 
  83. world that you have registered your copy.
  84.  
  85. Please register ValidOOR.  This program has been in development since December 
  86. of 1988, and has cost me a lot in the process.  Support the Shareware concept.  
  87. Registration of ValidOOR allows you to run ValidOOR on one computer system 
  88. ONLY.
  89.  
  90. In order to register ValidOOR, see the LICENSE.DOC file for an order entry 
  91. blank.  Fill out the form and send with the registration fee to:
  92.  
  93.     Cabell Clarke
  94.     5513 Cottage St.
  95.     Richmond, VA   23228
  96.  
  97. Your KEY file will be sent to you via FidoNet mail, or US Mail... whichever is 
  98. convenient.  Allow 2 weeks for processing.
  99.  
  100.  
  101. A Note about multi-line systems
  102. At this time, VD does not support file/record locking so it cannot be reliably 
  103. used on a multi-node bbs on more than one node.  It should work fine on one 
  104. node however.  I would like to add file/record locking to VD in the future.  
  105. Send Code<tm>.
  106.  
  107.  
  108.  
  109.  
  110. Getting Started
  111. In order to get going with VD, first you need to unzip all of the files into 
  112. your BBS or ValidOOR directory.  See the file PACKING.LST which accompanied 
  113. the VD ZIPchive to make sure you have all of the necessary files.  I recommend 
  114. printing this documentation.  I also recommend printing the VD.CFG file as it 
  115. contains helpful hints for setting up the configuration file in it's comments.  
  116. Modify (or create) the .MNU .ASC .BAT files included to suit your needs.  The 
  117. enclosed are samples only which I run on my system.  You are welcome to modify 
  118. my files for your own use keeping in mind that my setup may be somewhat 
  119. different from yours.
  120.  
  121. Rename the vd###.exe to VD.EXE
  122.  
  123.  
  124. Environment Variable
  125. You can run ValidOOR in its own sub-directory by setting the ValidOOR 
  126. environment variable to that sub-dir.  Two valid examples are:
  127.  
  128.     set validoor=d:\validoor\
  129.     set validoor=c:\bbs\vd
  130.  
  131. VD will find its sub-dir with or without the trailing backslash.  You should 
  132. place your vd.cfg and vd.key (registered users) in this sub-dir.  If you want 
  133. to place your executable files in this directory you should also include it in 
  134. your path like this:
  135.  
  136.     path=c:\bbs\vd
  137.  
  138.  
  139. Setting Up vd.cfg
  140. The VD.CFG file contains all of the important parameters necessary to run VD.  
  141. Please remember that any line which begins with a per-cent (%) is a comment 
  142. and may be removed, however, if you remove comments, you are on your own.  
  143. VD.CFG is well-commented and should be self explanatory in setting it up.  
  144. Just load it into your text editor.  Make sure that there are no comments on 
  145. the lines which contain parameters.  Also make sure that you only have one (1) 
  146. space between the Variable Descriptor and the variable itself like this:
  147.  
  148.     ModemSuffix &M4
  149.              ^
  150.         one space here
  151.  
  152.  
  153.  
  154. NOTE:
  155. In the many versions of ValidOOR there have been several vd.cfg file formats.  
  156. In this version, there are some new descriptors so it is suggested that you 
  157. modify the configuration file included in this archive to suit your setup.  
  158. Make sure the vd.cfg file you are using is compatible with your version of VD.
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168. Variable descriptors in vd.cfg
  169.  
  170. ---
  171. %
  172. - the percent sign is a comment and must be placed in the first column of the 
  173. line that you wish VD to ignore.  Do not place a '%' on the same line after a 
  174. variable descriptor or the program will not operate correctly.
  175.  
  176.  
  177. ---
  178. SysopName
  179. - Your name should go here.  This is required.  Example:
  180.  
  181.     SysopName Cabell Clarke
  182.  
  183.  
  184. ---
  185. YourCitySt
  186. - Tells VD what city and state your BBS resides in to notify the user where 
  187. the call will be originating so the user can tell VD if VD needs to dial a 1 
  188. to reach the User.
  189.  
  190.  
  191. ---
  192. Port
  193. - Port tells VD which communications port you are using.  Valid ports are 0-3 
  194. where port 0 = COM1 etc.  If you are using COM1 for your modem you would need:
  195.  
  196.     Port 0
  197.  
  198.  
  199. ---
  200. DialPrefix
  201. - This is the prefix that tells your modem how to dial out.  Mine looks like 
  202. this:
  203.  
  204.     DialPrefix ATDT
  205.  
  206.  
  207. ---
  208. AreaCode
  209. - This Variable is used to tell VD which area code(s)you can place a local 
  210. call to.  You may have up to 5 local area codes in VD.CFG...  for instance 
  211. someone who lives in Washington DC might have a VD.CFG which looks like this:
  212.  
  213.     AreaCode 202    <-- your area code first
  214.     AreaCode 301
  215.     AreaCode 703
  216.  
  217. This is because he does not need to use an area code to dial any of these 
  218. three areas.  Maximum of 5 local area codes supported at this time. Make sure 
  219. that your own area code is listed in the file first.
  220.  
  221.  
  222. ---
  223. InvalidExchange
  224. - This descriptor tells ValidOOR about 3 digit exchanges which are invalid 
  225. like 911 in some areas.  ValidOOR treats these exchanges very harshly so use 
  226. them with care.  If a user attempts to get ValidOOR to dial a number with one 
  227. of these exchanges, ValidOOR will disconnect them from the system.  You may 
  228. use a maximum of 10 of these.  Examples:
  229.  
  230.     InvalidExchange 911
  231.     InvalidExchange 411
  232.  
  233.  
  234. ---
  235. PreDialLDCode
  236. - This descriptor is the prefix used by your phone system for dialing a long 
  237. distance call.  The default value is 1.
  238.  
  239.     PreDialLDCode 1
  240.  
  241.  
  242. ---
  243. NotFirstDigit
  244. - This descriptor tells ValidOOR about invalid first digits in phone number 
  245. exchanges.  ValidOOR will refuse to dial numbers with these digits first.  I 
  246. use the two below.
  247.  
  248.     NotFirstDigit 0
  249.     NotFirstDigit 1
  250.  
  251.  
  252. ---
  253. Phone
  254. - This variable is used to tell VD how your BBS saves the user's phone number.  
  255. When a new user logs on if you ask for both Home Phone Number and 
  256. Data/Business Phone number then your VD.CFG file would need the following:
  257.  
  258.     Phone HomePhone
  259.     Phone DataPhone
  260.  
  261. If you only ask them for their Home Phone Number then your VD.CFG file would 
  262. only need this:
  263.  
  264.     Phone HomePhone
  265.  
  266.  
  267. ---
  268. YourCodeLD
  269. - This one will allow you to tell VD not to strip your area code from long 
  270. distance numbers in your area code - I call this Ed Marquis mode <grin> since 
  271. it was his requirement which prompted the addition of it.
  272.  
  273.     YourCodeLD NoStrip
  274.  
  275. If you don't use this VD will default to stripping them anyway.
  276.  
  277.  
  278. ---
  279. LongDistance
  280. - The LongDistance descriptor enables/disables Long Distance calling.  If you 
  281. do not want VD to make a long distance call you would have the following in 
  282. your VD.CFG file:
  283.  
  284.     LongDistance NoLDCall
  285.  
  286. If you want VD to make a Long Distance call (whether using slots or not), you 
  287. would use:
  288.  
  289.     LongDistance LDCall
  290.  
  291. This one would make long distance calls at any time or allow you to use the 
  292. slots below if you want to.
  293.  
  294.  
  295. ---
  296. LDSlotDefault
  297. - This variable tells VD the default slot of time for making long Distance 
  298. calls.  This slot is always in effect unless commented out or overridden by a 
  299. daily slot.  The correct usage is:
  300.  
  301.     LDSlotDefault <starttime> <stoptime>
  302.  
  303. Example:
  304.  
  305.     LDSlotDefault 2200 0700
  306.  
  307. The above would allow your system to make long distance calls between 10pm and 
  308. 7am on all days providing the LongDistance variable is enabled as shown above.
  309.  
  310.  
  311. ---
  312. LDSlotSun
  313. LDSlotMon
  314. LDSlotTue
  315. LDSlotWed
  316. LDSlotThu
  317. LDSlotFri
  318. LDSlotSat
  319. - These are the daily slots which will override the default slot above.  The 
  320. syntax for these is the same as above:
  321.  
  322.     LDSlotSat 0000 2359
  323.     LDSlotSun 0000 1659
  324.  
  325. The two examples above would allow your system to call long distance all day 
  326. Saturday and all day before 5pm on Sunday.  The rest of the days would use the 
  327. default slot above.
  328.  
  329.  
  330. ---
  331. MaxAttempts
  332. - This variable tells VD how many times to attempt to call a user with NO 
  333. CONNECT!  If you only wanted to try twice you'd have:
  334.  
  335.     MaxAttempts 2
  336.  
  337. VD will only call once if a connection is made.  This is hard-coded into the 
  338. program and cannot be modified.
  339.  
  340.  
  341. ---
  342. ModemTimeOut
  343. - This is the number of seconds you want VD to wait for a carrier before 
  344. recycling.  NOTE:  For maximum efficiency You should also set this value in 
  345. register S7 of your modem in your modem initialization string. (S7=45). See 
  346. ModemInit below.
  347.  
  348.     ModemTimeOut 45
  349.  
  350.  
  351. ---
  352. UserTimeOut
  353. - This is the number of seconds to wait for input from the user before timing 
  354. out due to INACTIVITY.
  355.  
  356.     UserTimeOut 40
  357.  
  358.  
  359. ---
  360. ModemInit
  361. - This is the string that you want VD to use to initialize your modem.  I use 
  362. this for my HST:
  363.  
  364.     ModemInit AT S0=0 E0 X6 S7=45|
  365.  
  366. Note the s7=45 which is the same as the 45 in the ModemTimeOut variable above.  
  367. If you want VD to ignore result codes use an X0 in this string but remember if 
  368. you use an X0, all Bad Number/VOICE connect processing will be eliminated.  
  369. The "|" character adds a carriage return to your string.
  370.  
  371.  
  372. ---
  373. ModemReset
  374. - This variable tells VD whether you want to reset your modem before you 
  375. initialize it.  If you want to reset it enter the string you want to send to 
  376. it like this:
  377.  
  378.     ModemReset ATZ|
  379.  
  380. Note the '|' sends a carriage return.
  381.  
  382.  
  383. ---
  384. LogPath
  385. - This is the path to your VD Log File where a log of VD's activities are 
  386. kept.  I use:
  387.  
  388.     LogPath d:\qbbs\validoor.log
  389.  
  390.  
  391.  
  392.  
  393. ---
  394. LogStyle
  395. - this allows you to make your log look like an Opus/Binkley or FrontDoor 
  396. style log.  Valid descriptors are:
  397.  
  398.     LogStyle BINK
  399.     LogStyle FD
  400.  
  401.  
  402. ---
  403. ExitInfoPath
  404. - another optional descriptor which tells VD where it can find your 
  405. EXITINFO.BBS file.  Requires full path and filename.  Default is current 
  406. directory.
  407.  
  408.     ExitInfoPath c:\bbs\exitinfo.bbs
  409.  
  410.  
  411. ---
  412. UserPath
  413. - this descriptor is here for VD_Pack to use to find the Users.BBS file.  
  414. ValidOOR will ignore it.  Again a full path and filename is required.
  415.  
  416.     UserPath c:\bbs\users.bbs
  417.  
  418.  
  419. ---
  420. UserDir
  421. - This is the Path and filename of your User Directory where the names and 
  422. phone numbers of validated users are stored.  This is to make sure that users 
  423. cannot be validated twice at the same phone number. I use:
  424.  
  425.     UserDir c:\bbs\validoor.dir
  426.  
  427. This is an optional feature and may be disabled by commenting it out.
  428.  
  429.  
  430. ---
  431. BadNumber
  432. - This is the full Path and filename to your Bad Phone Number Control file.  
  433. This file is where any phone numbers that ValidOOR senses to be VOICE connects 
  434. will be written and therefore prevented from ever being dialed by ValidOOR 
  435. again.  If you wish you may use your BBS PHONENUM.CTL file for this, 
  436. remembering that any numbers that end up in PHONENUM.CTL will never be dialed 
  437. by ValidOOR.  Usage as follows:
  438.  
  439.     BadNumber d:\qbbs\badnumbr.ctl
  440.     BadNumber d:\qbbs\phonenum.ctl
  441.  
  442. If you do not wish to use this feature, simply comment it out.  It is 
  443. optional.
  444.  
  445.  
  446. ---
  447. EditPhone
  448. - This allows a user to edit his phone number from within ValidOOR.  It has 
  449. three parameters which do the following:
  450.  
  451.     EditPhone 0
  452.         Do not allow user to edit phone number
  453.     EditPhone 1
  454.         Allow user to edit phone number
  455.     EditPhone 2
  456.         Allow user to edit phone number & update Users.BBS
  457.  
  458.  
  459. ---
  460. ModemSuffix
  461. - This is for modems like the HST which can use a suffix after the phone 
  462. number to cause a certain type of connection to be made.  Comment it out if 
  463. you don't need it.  With my HST I use:
  464.  
  465.     ModemSuffix &M4
  466.  
  467.  
  468. ---
  469. WaitTime
  470. - This is the number of seconds to wait before the first attempted call and 
  471. between each attempted call.  I suggest using 10 seconds:
  472.  
  473.     WaitTime 10
  474.  
  475.  
  476. ---
  477. OffHook
  478. - This is the string you wish to use to take your modem offhook during the 
  479. above WaitTime to keep an incoming call from messing up VD's validation 
  480. attempt.  I use this for my HST:
  481.  
  482.     OffHook ATH1|
  483.  
  484.  
  485.  
  486.  
  487.  
  488. ---
  489. OnHook
  490. - This string puts the modem back on hook after WaitTime before a call is 
  491. made.  I use:
  492.  
  493.     OnHook ATH0|
  494.  
  495.  
  496. ---
  497. ValidGoodbye
  498. - This is the full path and filename to a text file that you wish to be 
  499. displayed to the user who has been validated successfully.  I use:
  500.  
  501.     ValidGoodbye c:\bbs\text\validgb.asc
  502.  
  503. ---
  504. InValidGoodBye
  505. - This is the path to a text file to be displayed to a user that is not 
  506. validated successfully. Mine is:
  507.  
  508.     InValidGoodbye c:\bbs\text\invaldgb.asc
  509.  
  510.  
  511. ---
  512. LDGoodbye
  513. - This file will be displayed to a user when Long Distance calls have been 
  514. disabled. I use:
  515.  
  516.     LDGoodbye c:\bbs\text\ldgoodby.asc
  517.  
  518.  
  519. ---
  520. HitAnyKey
  521. - This is for High-Speed modem users who run with the port locked.  It places 
  522. a "Hit ANY Key" at the end of each 'goodbye' file above, so that the user will 
  523. see all of the file before the modem disconnects.  If your port is not locked 
  524. use:
  525.  
  526.     HitAnyKey No
  527.  
  528. If your port is locked use:
  529.  
  530.     HitAnyKey Yes
  531.  
  532.  
  533.  
  534.  
  535.  
  536.  
  537. ---
  538. SlowModem
  539. - This descriptor enables commands sent to the modem slowly for modems that 
  540. cannot respond to an initialization string sent at full blast! Usage:
  541.  
  542.     SlowModem On
  543.     SlowModem Off
  544.  
  545.  
  546. ---
  547. ForeGround
  548. BackGround
  549. - Color Attributes for Normal Activity Window
  550.  
  551. ---
  552. MessageForeGround
  553. MessageBackGround
  554. - Color Attributes for Message Bar
  555.  
  556. ---
  557. StatusForeground
  558. StatusBackground
  559. - Color Attributes for Status Info
  560.  
  561. ---
  562. WindowForeGround
  563. WindowBackGround
  564. - Color Attributes for Status Window
  565.  
  566. I  use these:
  567.  
  568.  
  569.     ForeGround 7
  570.     BackGround 0
  571.     MessageForeGround 4
  572.     MessageBackGround 7
  573.     StatusForeground 15
  574.     StatusBackground 3
  575.     WindowForeGround 0
  576.     WindowBackGround 3
  577.     
  578.  
  579. ---
  580. SecLevel
  581. - This is the security level you want to set validated users to:
  582.  
  583.     SecLevel 5
  584.  
  585. If you do not want Validoor to set any levels, then comment out this line.
  586.  
  587.  
  588. ---
  589. AFlag
  590. BFlag
  591. CFlag
  592. DFlag
  593. - These descriptors define the bit masks for the user flags. You set them just 
  594. like you would in your user editor.  If you don't want VD to mess with user 
  595. flags, just comment them out.  Using the letter 'n' in place of any bit will 
  596. cause VD to leave that bit untouched.
  597.  
  598.     AFlag XXXX---n
  599.     % BFlag --------
  600.     CFlag X-X-X-Xn
  601.     % DFlag --------
  602.  
  603. Above the AFlag and CFlag would be set like above for a user who passes 
  604. validation successfully.  The BFlag and DFlag would not be touched.  Bit 8 on 
  605. both AFlag and CFlag would be untouched by ValidOOR.
  606.  
  607.  
  608. ---
  609. TimeLimit
  610. - Use this to set the new time limit for the user after he is validated.
  611.  
  612.     TimeLimit 60
  613.  
  614. would give a newly validated user 60 minutes.  This is useful if you let newly 
  615. validated users back into your system after you call them (on your nickel).  
  616. Comment this out to disable this feature.
  617.  
  618.  
  619. ---
  620. TwitLine
  621. - This can be a line of text displayed to a user you have just 'Twitted' with 
  622. the <F10> Twit key.
  623.  
  624.     TwitLine Please Call some other BBS
  625.  
  626. The default twitline if you don't use this descriptor is:
  627.  
  628.     "System Error - Disconnecting..."
  629.  
  630.  
  631. ---
  632. ValidShell
  633. - This is used to get your system to run external programs after validating 
  634. Users.  You may have up to 10 ValidShells which are executed in the order they 
  635. are listed in VD.Cfg.  Example below would run the program Postit.Exe
  636.  
  637.     ValidShell Postit.Exe -t@UserName -f"Sysop" -mtext.txt
  638.  
  639. NOTE the use of the VDVariable @UserName.  ValidOOR will replace this variable 
  640. with the user's name.  See VDVariables section for details:
  641.  
  642.  
  643. ---
  644. UserComment
  645. - This will put a comment in the Usersxi.bbs file.  It also understands 
  646. VDVariables.
  647.  
  648.     UserComment ValidOOR v@Version at @VD_Time on @VD_Date
  649.  
  650.  
  651. ---
  652. Language
  653. - The name of your ValidOOR language file.  Use a full path if you are not 
  654. using the environment variable.  The ASC/ANS extension is added so do not put 
  655. an extendion on it.  If not used, ValidOOR will default to VD-LANG.  Example:
  656.  
  657.     Language VooDoo
  658.  
  659.  
  660.  
  661. %%%  End of VD.CFG  %%%
  662.  
  663.  
  664.  
  665. In ALL of the above descriptors the CASE is not significant but it may be in 
  666. your modem commands depending on your modem.
  667.  
  668. The default filename for your configuration file is VD.CFG.  You may also tell 
  669. Validoor the name of your configuration file on the command line when you run 
  670. it like this:
  671.  
  672.     vd myvd.cfg
  673.        or
  674.     vd yourvd.cfg
  675.  
  676. You should NOT include a Path to your vd.cfg on the command line unless you 
  677. are not using the ValidOOR environment variable.
  678.  
  679.  
  680. VD_Variables
  681. ------------
  682. VD_Variables are output variables that you can use in interfacing VD with the 
  683. caller as well as the outside world.  Generally they work like this.  When VD 
  684. encounters a vd_var it will replace that vd_var with a corresponding piece of 
  685. data from within ValidOOR.  These work in several places in ValidOOR such as 
  686. in the User Comment field, as well as the ValidShell execution.  Some of them 
  687. are also VERY useful in the language file as you will see when you examine the 
  688. enclosed language file.
  689.  
  690. There are a total of fourteen vd_vars.  They and their functions are listed 
  691. below:
  692.  
  693.     @UserName        User's First & Last name
  694.                     Format: Ken Givens
  695.     @User_Name        Same as @UserName except
  696.                     Format: Ken_Givens
  697.     @Version        ValidOOR Current Version
  698.     @VD_Date        Current Date
  699.     @VD_Time        Current Time
  700.     @LDCode         PreDialLDCode from vd.cfg
  701.     @Sysop          SysopName from vd.cfg
  702.     @VD_EOL         inserts CR/LF characters (careful with this)
  703.     @Home            Key for selecting HomePhone from menu
  704.     @Data            Key for selecting DataPhone from menu
  705.     @Abort          Key for selecting Abort ValidOOR from menu
  706.     @Edit            Key for selecting to edit phone number from menu
  707.     @Yes            Key for selecting Yes response
  708.     @No             Key for selecting No response
  709.  
  710. The last few which are selection keys from the menu, etc. are particularly 
  711. useful in the language file.  If you use them there, anytime you change the 
  712. key definitions in vd.cfg, the new definitions will automatically be plugged 
  713. into the language file at runtime.  This results in less work for you.
  714.  
  715.  
  716.  
  717. Interfacing ValidOOR
  718. There are several ways you can run ValidOOR on your system.  I use a type 40 
  719. command in my TOP.MNU with flag D1 set ON (X) to force all new users into the 
  720. validation menu.  After successful validation I set the D1 flag back off (-) 
  721. and then when they hit TOP.MNU the 1st type 40 command will be ignored due to 
  722. the flag not being ON and the TOP.MNU will execute normally.  I have included 
  723. my menus in this archive to give you an idea as to how I do it.
  724.  
  725. You can also just use a Type 2 command to let your users access VD that way...  
  726. it is up to your personal preference as to how you get your users into 
  727. ValidOOR.  Be creative :-).  That is why the system has been designed to be so 
  728. open-ended.
  729.  
  730. Once the user selects ValidOOR, the BBS should exit via type 15 or type 7 EXIT 
  731. to run ValidOOR.  See your BBS documentation for an explanation of Type 7 and 
  732. 15 Exits.  I use a type 15 EXIT to my RunRa.Bat file which then calls my 
  733. Validate.Bat which I have included here.  When the Validate.Bat file runs it 
  734. loads ValidOOR which then initializes the FOSSIL driver, and does some setup 
  735. things - reads VD.CFG which you the sysop must set up, and then it looks for 
  736. EXITINFO.BBS.
  737.  
  738. At this point, if you have opted to use a User Directory File to prevent 
  739. duplicate phone numbers, VD will check for the existence of this file which it 
  740. creates if not found.  If you comment out the UserDir descriptor in VD.Cfg, no 
  741. dupe checking will be performed.
  742.  
  743. ValidOOR also creates a log file and appends info to it so you can keep track 
  744. of it's activities.
  745.  
  746. ValidOOR can be set up to use either the business/data phone number, the 
  747. home/voice phone number or both phone numbers that the user entered during his 
  748. initial login depending on how you choose to set up your BBS.  You can also 
  749. optionally allow the user to edit his phone number in two different ways - 1) 
  750. temporary edit for calling which is not saved, or 2) edit which is saved into 
  751. the DATAPHONE field in the users.bbs file.  If you are going to allow your 
  752. users to edit their number from within ValidOOR it is highly recommended that 
  753. you use option 2 and save the edits.  This is more secure.
  754.  
  755. ValidOOR will prompt the user to select which of the two numbers his modem is 
  756. currently connected to and give him an option to abort the process should he 
  757. so desire.  After this selection is made, ValidOOR will ask him if a 1- should 
  758. be placed in front of the number for a long distance call.  If you choose not 
  759. to let VD make long distance calls, the user will not be called and a file 
  760. explaining the situation can be displayed (See VD.CFG descriptor LDGoodbye.  
  761. If Long distance calling is enabled, VD will place the 1- in front of his 
  762. number and continue with the process.
  763.  
  764. If all files are present and everything went properly, ValidOOR will inform 
  765. the user that he is about to be validated and display the following line:
  766.  
  767. "Prepare for an incoming call.  If your modem will not auto answer, when you 
  768. see the RING on screen type ATA and hit <Enter>."
  769.  
  770. Then ValidOOR prompts him to hit <ENTER> when he is ready to begin.  When the 
  771. user hits <ENTER> ValidOOR will disconnect him, take the phone off the hook, 
  772. and wait a pre-defined number of seconds (WaitTime in VD.CFG).  The ValidOOR 
  773. will put the modem back on the hook and call the user at the same baud rate 
  774. that he used to log into the BBS. The number of "Non-Connect" attempts can be 
  775. set up in VD.CFG but the system, after one connection is made, will not make 
  776. another attempt to call.
  777.  
  778. If your modem is capable of sensing a VOICE connect, and your modem 
  779. initialization string has the proper value sent to it to enable this feature, 
  780. then when ValidOOR senses a VOICE connection and you have a path in the 
  781. 'BadNumber' descriptor uncommented, ValidOOR will abort and write this phone 
  782. number to a BadNumber Control file.  Then VD will never attempt to call this 
  783. number again.  You may use your PHONENUM.CTL file in your BBS for this if you 
  784. fully understand that no one ever be able to use this number to log in to your 
  785. BBS as a new user again. Using X0 in your Modem Initialization string will 
  786. totally disable modem result codes and then ValidOOR will ignore all of this 
  787. entirely.
  788.  
  789. When the connection is successful, ValidOOR will display a brief message 
  790. something like this:
  791.  
  792. ValidOOR v1.60
  793.  
  794. and then display the SysName1 and SysName2 messages that you set up in VD.CFG.  
  795. Next VD prompts the user to enter his password.  He gets three tries before 
  796. ValidOOR gives up and disconnects.  An Inactivity timer which is configurable 
  797. in VD.CFG will disconnect him if he falls asleep.  If he fails to enter the 
  798. proper password (from EXITINFO.BBS) for whatever reason, the system will 
  799. disconnect him and exit with an errorlevel 2.  Your batch file can then 
  800. process the errorlevel accordingly.  An appropriate entry will be written to 
  801. the log.
  802.  
  803. If he is successful, then ValidOOR will exit with an errorlevel 0.  Your batch 
  804. file can process accordingly.  Also an entry will be written into the log file 
  805. to let you know what happened.  If you have selected to do so in VD.CFG, and 
  806. are running from a type 15 exit, ValidOOR will update the user's security and 
  807. user flags in the EXITINFO.BBS.
  808.  
  809. NOTE:  It is necessary to reload your BBS after VD exits using the command:
  810.  
  811.     RA -R
  812.  
  813. in order for the changes in security level and user flags to take place.  If 
  814. you do not reload your BBS the updates will NOT be written to the USERS.BBS 
  815. file.  See my SPAWNBBS.BAT file for an exact example as to how this should be 
  816. done.
  817.  
  818.  
  819. Function Keys
  820. Some function keys are available to the sysop while a user is online.
  821.  
  822. <F1>  - Chat
  823. - Pressing this key will put you in Chat Mode with the caller.  Hitting <ESC> 
  824. will exit the chat mode.
  825.  
  826. <F2>  - DOS
  827. - This key will allow you to shell to DOS via your Comspec variable.  Be sure 
  828. you have set comspec in your environment.
  829.  
  830. <F3>  - Twit
  831. - This Key will set the callers access level to Zero (0) thus banning him from 
  832. entering you system forever.  VD exits with errorlevel 18. Use this with 
  833. caution and prudence.
  834.  
  835. <F4>  - Abort
  836. - This key simply aborts VD and exits with a DOS errorlevel 15.
  837.  
  838. <F5>  - HangUp
  839. - This key disconnects the user and exits with a DOS errorlevel 16.
  840.  
  841. <F10> - Advertisement
  842. - This key interrupts ValidOOR processing with an advertisement.
  843.  
  844. Local Mode
  845. ValidOOR has a Local Mode that a sysop can use for testing purposes.  You must 
  846. exit (type 15 or 7) from the BBS (in local) for it to work.  VD can tell from 
  847. Exitinfo.Bbs that you are in LOCAL mode and will react accordingly.  While in 
  848. Local mode, VD will not check to see if the phone number exists in the User 
  849. Directory file.  This will allow you to test as many times as you like without 
  850. having to delete yourself from the User Directory every time.
  851.  
  852. In local mode, VD will skip the dialing and jump straight to Connection and 
  853. attempt to validate you.  Your phone number will be written into the User 
  854. Directory if you pass the validation.
  855.  
  856.  
  857.  
  858.  
  859.  
  860.  
  861. ERRORLEVELS
  862. Several cases will cause ValidOOR to abort with an errorlevel:
  863.  
  864. *    absence of any of these files:               errorlevel=1
  865.     EXITINFO.BBS
  866.     VD.CFG
  867.  
  868. *    User Not Validated                           errorlevel=2
  869.  
  870. *    SysopName missing in VD.CFG                  errorlevel=3
  871.  
  872. *    Duplicate Phone Number (in directory file)   errorlevel=4
  873.  
  874. *    User Abort at Menu                           errorlevel=5
  875.  
  876. *    Absence of FOSSIL Comm Driver                errorlevel=6
  877.  
  878. *    Long Distance attempt (if enabled)           errorlevel=7
  879.  
  880. *    Inactivity                                   errorlevel=8
  881.  
  882. *    Carrier Loss                                 errorlevel=9
  883.  
  884. *    VOICE connect detection                      errorlevel=10
  885.  
  886. *    Bad Number detected (BadNumber Control File) errorlevel=11
  887.  
  888. *    Bad KEY file                                 errorlevel=12
  889.  
  890. *    Invalid # of Command Line Args               errorlevel=13
  891.  
  892. *    User Edited invalid number                   errorlevel=14
  893.  
  894. *    F4 Abort key                                 errorlevel=15
  895.  
  896. *    F5 Hangup key                                errorlevel=16
  897.  
  898. *    Beta Copy expired (betas ONLY)               errorlevel=17
  899.  
  900. *    Twitted the current user                     errorlevel=18
  901.  
  902. *    FATAL System ERROR                           errorlevel=19
  903.  
  904. *    Non-registered User running BETA version     errorlevel=20
  905.  
  906. *    If the user is validated successfully, ValidOOR will exit with an 
  907. errorlevel of 0.
  908.  
  909. These errorlevels are enabled in this release.  They are not guaranteed to 
  910. remain the same in future versions.  You can take advantage of these 
  911. errorlevels by trapping them all in your batch file and using the traps to 
  912. generate entries in your log to give you a more verbose explanation of what 
  913. went on....  be creative.  You can use them any way you like.
  914.  
  915.  
  916. Your KEY file
  917. The ValidOOR Key file eliminates the 30 second delay at the beginning of the 
  918. program.  You must register ValidOOR in order to get a key from me.  I can 
  919. send the key via FidoNet mail or US Mail (Snail Mail).  Please specify which 
  920. method you prefer when registering ValidOOR.
  921.  
  922.  
  923. Reporting Bugs
  924. If you have a problem with ValiDOOR you should report it immediately to me.  
  925. When making a bug report, please include the following info in a ZIPPED file:
  926.  
  927.     A detailed description of the problem
  928.     A copy of your VD.CFG file
  929.     A copy of your log showing the problem if applicable
  930.     A copy of your UserDir if applicable
  931.     A copy of your badnumbr.ctl file if applicable
  932.  
  933. Without this info, it will be nearly impossible for me to find the problem.  
  934. Help me to help you.
  935.  
  936. The best place to report a problem in on my support system listed here:
  937.  
  938.     ValidOOR Support
  939.     The Boot Factory BBS
  940.     FidoNet 1:264/19
  941.     804-262-9289
  942.  
  943. I also try to read the RA_UTIL echo regularly but that is not guaranteed to be 
  944. true at any given time.
  945.  
  946.  
  947. File Requests
  948. Magic Filenames for File Requests from 1:264/19
  949.  
  950. FILES     : master download file list F264-019.ZIP
  951. NEWFILES  : Files less than 30 days old
  952. ABOUT     : General Info File
  953. VDR       : latest version of ValidOOR - for RA
  954. VDQ       :   "       "    "     "        "  QuickBBS
  955. VDU       : VD_Util for vd.cfg, language and Userdir files
  956. The following utils will ONLY work with a key.
  957. VDP       : VD_Pack   - userdir packer for registered users
  958. VDC       : VD_Create - userdir creator for registered users
  959.  
  960.  
  961. Credits
  962. Thanks to the following individuals:
  963.  
  964. Continental Software  -  The RemoteAccess folks.
  965. Robert Rosanio        -  who gave me the original idea.
  966. Greg Dawson           -  for teaching me how to access FOSSIL.
  967. Mike Janke            -  for his wonderful Exit code.
  968. Jim Whitby            -  for Documentation and other Help.
  969. Ed Greene             -  for his debugging help and reports.
  970. Richard Alfoni        -  for his debugging help and reports.
  971. Tom Meehan            -  Chief code basher/tester.
  972. Ken Givens            -  Invaluable Suggestions and Help
  973. Net 264               -  for tolerance.
  974.  
  975.  
  976. Also Thanks to the Beta Testers....  All of you.
  977.  
  978.  
  979. Report ALL to:
  980. Cabell Clarke
  981. 804-262-9289 DATA
  982. FidoNet 1:264/19
  983.  
  984.  
  985.